pascal Boolean HRHTMLRenderingLibAvailable()
HRHTMLRenderingLibAvailable returns true if the HTMLRenderinLib is available for your application to use, false if it is not. If you have weak-linked your application to the HTMLRenderingLib, then this function can be used to determine if the library was loaded when your program was launched.
pascal OSStatus HRGetHTMLRenderingLibVersion( NumVersion *returnVers)returnVers - A pointer to a NumVersion structure. On return, this structure contains a value.
function result - an error code.
HRGetHTMLRenderingLibVersion returns the version of the HTMLRenderingLib that is currently installed.
pascal OSStatus HRNewReference( HRReference *hrRef, OSType rendererType, grafPtr GrafPtr)hrRef - is a pointer to a location to store the newly created HRReference when HRNewReference is able to run successfully.
rendererType - A value of type OSType identifying the type of HTML renderer available. Currently, the constant kHRRendererHTML32Type is the only value you may pass in this parameter.
grafPtr - the quickdraw grafport where the HTML should be drawn.
HRNewReference creates a new reference to a HTML rendering object for your application to use in conjunction with other HTMLRenderingLib calls.
pascal OSStatus HRDisposeReference( HRReference hrRef)hrRef - a reference to a HTML rendering object previously obtained by calling HRNewReference.
HRDisposeReference deallocates the HTML rendering object freeing up structures associated with the reference.
NOTE: HRDisposeReference does not deallocate any files cached in the HTMLRenderingLib's memory cache. To deallocate the cache, you must make call to HRFreeMemory.
Attempts to release cache memory for use by your application.
pascal SInt32 HRFreeMemory( Size inBytesNeeded)inBytesNeeded - the total number of bytes needed.
function result - the number of bytes released from cache memory by the HRFreeMemory call.
HRFreeMemory can be called to return memory occupied by the HTMLRenderingLib's memory cache to the application.
pascal void HRScreenConfigurationChanged()
HRScreenConfigurationChanged should be called whenever the depth of the screen changes. This allows the HTML Rendering Library to adjust its drawing parameters so they are appropriate for the screen's depth.
pascal Boolean HRIsHREvent( const EventRecord *eventRecord)eventRecord - a pointer to an event record returned by WaitNextEvent
HRIsHREvent returns true if the HTML Rendering Library handled the event. If HRIsHREvent returns false, then the event was not handled and your application should go ahead and process the event. You should call HRIsHREvent every time after calling WaitNextEvent to give the HTML Rendering Library an opportunity to handle the event.